home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / EXTENSIONS.PY < prev    next >
Encoding:
Python Source  |  2000-07-05  |  8.9 KB  |  247 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. __doc__='''Standard routines for handling extensions.
  86.  
  87. Extensions currently include external methods and pluggable brains.
  88.  
  89. $Id: Extensions.py,v 1.12.36.2 2000/07/05 21:20:41 brian Exp $'''
  90. __version__='$Revision: 1.12.36.2 $'[11:-2]
  91.  
  92. from string import find, split
  93. import os, zlib, rotor, imp
  94. import Products
  95. path_split=os.path.split
  96. path_join=os.path.join
  97. exists=os.path.exists
  98.     
  99. class FuncCode:
  100.  
  101.     def __init__(self, f, im=0):
  102.         self.co_varnames=f.func_code.co_varnames[im:]
  103.         self.co_argcount=f.func_code.co_argcount-im
  104.  
  105.     def __cmp__(self,other):
  106.         if other is None: return 1
  107.         try: return cmp((self.co_argcount, self.co_varnames),
  108.                         (other.co_argcount, other.co_varnames))
  109.         except: return 1
  110.  
  111.  
  112. def _getPath(home, prefix, name, suffixes):
  113.     d=path_join(home, prefix)
  114.     if d==prefix: raise ValueError, (
  115.         'The prefix, %s, should be a relative path' % prefix)
  116.     d=path_join(d,name)
  117.     if d==name: raise ValueError, ( # Paranoia
  118.         'The file name, %s, should be a simple file name' % name)
  119.     for s in suffixes:
  120.         if s: s="%s.%s" % (d, s)
  121.         else: s=d
  122.         if exists(s): return s
  123.  
  124. def getPath(prefix, name, checkProduct=1, suffixes=('',)):
  125.     """Find a file in one of several relative locations
  126.  
  127.     Arguments:
  128.  
  129.       prefix -- The location, relative to some home, to look for the
  130.                 file
  131.  
  132.       name -- The name of the file.  This must not be a path.
  133.  
  134.       checkProduct -- a flag indicating whether product directories
  135.         should be used as additional hope ares to be searched. This
  136.         defaults to a true value.
  137.  
  138.         If this is true and the name contains a dot, then the
  139.         text before the dot is treated as a product name and
  140.         the product package directory is used as anothe rhome.
  141.  
  142.       suffixes -- a sequences of file suffixes to check.
  143.         By default, the name is used without a suffix.
  144.  
  145.     The search takes on multiple homes which are INSTANCE_HOME,
  146.     the directory containing the directory containing SOFTWARE_HOME, and
  147.     possibly product areas.     
  148.     """
  149.     d,n = path_split(name)
  150.     if d: raise ValueError, (
  151.         'The file name, %s, should be a simple file name' % name)
  152.  
  153.     if checkProduct:
  154.        l = find(name, '.')
  155.        if l > 0:
  156.            p = name[:l]
  157.            n = name[l + 1:]
  158.            for product_dir in Products.__path__:
  159.                r = _getPath(product_dir, '%s/%s/' % (p, prefix), n, suffixes)
  160.                if r is not None: return r
  161.  
  162.     sw=path_split(path_split(SOFTWARE_HOME)[0])[0]
  163.     for home in (INSTANCE_HOME, sw):
  164.         r=_getPath(home, prefix, name, suffixes)
  165.         if r is not None: return r
  166.  
  167. def getObject(module, name, reload=0,
  168.               # The use of a mutable default is intentional here,
  169.               # because modules is a module cache.
  170.               modules={} 
  171.               ):
  172.  
  173.     # The use of modules here is not thread safe, however, there is
  174.     # no real harm in a rece condition here.  If two threads
  175.     # update the cache, then one will have simply worked a little
  176.     # harder than need be.  So, in this case, we won't incur
  177.     # the expense of a lock.
  178.     if modules.has_key(module):
  179.         old=modules[module]
  180.         if old.has_key(name) and not reload: return old[name]
  181.     else:
  182.         old=None
  183.  
  184.     if module[-3:]=='.py': p=module[:-3]
  185.     elif module[-4:]=='.pyp': p=module[:-4]
  186.     elif module[-4:]=='.pyc': p=module[:-4]
  187.     else: p=module
  188.     p=getPath('Extensions', p, suffixes=('','py','pyp','pyc'))
  189.     if p is None:
  190.         raise "Module Error", (
  191.             "The specified module, <em>%s</em>, couldn't be found." % module)
  192.  
  193.     __traceback_info__=p, module
  194.  
  195.  
  196.     if p[-4:]=='.pyc':
  197.         file = open(p, 'rb')
  198.         binmod=imp.load_compiled('Extension', p, file)
  199.         file.close()
  200.         m=binmod.__dict__
  201.  
  202.     elif p[-4:]=='.pyp':
  203.         prod_id=split(module, '.')[0]
  204.         data=zlib.decompress(
  205.             rotor.newrotor(prod_id +' shshsh').decrypt(open(p,'rb').read())
  206.             )
  207.         execsrc=compile(data, module, 'exec')
  208.         m={}
  209.         exec execsrc in m
  210.         
  211.     else:
  212.         try: execsrc=open(p)
  213.         except: raise "Module Error", (
  214.             "The specified module, <em>%s</em>, couldn't be opened."
  215.             % module)
  216.         m={}
  217.         exec execsrc in m
  218.  
  219.     try: r=m[name]
  220.     except KeyError:
  221.         raise 'Invalid Object Name', (
  222.             "The specified object, <em>%s</em>, was not found in module, "
  223.             "<em>%s</em>." % (name, module))
  224.  
  225.     if old:
  226.         for k, v in m.items(): old[k]=v
  227.     else: modules[module]=m
  228.  
  229.     return r
  230.  
  231. class NoBrains: pass
  232.  
  233. def getBrain(module, class_name, reload=0):
  234.     'Check/load a class'
  235.  
  236.     if not module and not class_name: return NoBrains
  237.  
  238.     try: c=getObject(module, class_name, reload)
  239.     except KeyError, v:
  240.         if v == class_name: raise ValueError, (
  241.             'The class, %s, is not defined in file, %s' % (class_name, module))
  242.  
  243.     if not hasattr(c,'__bases__'): raise ValueError, (
  244.         '%s, is not a class' % class_name)
  245.     
  246.     return c
  247.